Esx Settings Clusters Vms LifecycleHooks ProcessedHookSpec

Esx Settings Clusters Vms LifecycleHooks ProcessedHookSpec
Esx Settings Clusters Vms LifecycleHooks ProcessedHookSpec

The Esx Settings Clusters Vms LifecycleHooks ProcessedHookSpec schema contains properties that describe a specification for marking a hook as processed.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "vm": "string",
    "lifecycle_state": "string",
    "processed_successfully": false
}
string
vm
Required

Identifier of the VM whose hook needs to be marked as processed.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.

string
lifecycle_state
Required

Expected VM lifecycle state of the VM specified by the vm for which the hook is activated.

For more information see: Esx Settings Clusters Vms LifecycleState.

This property was added in vSphere API 9.0.0.0.

boolean
processed_successfully
Required

Result of the client hook processing. True if processed successfully, false otherwise.

This property was added in vSphere API 9.0.0.0.

Parameter To